#ifndef MUPDF_FITZ_PIXMAP_H #define MUPDF_FITZ_PIXMAP_H

#include “mupdf/fitz/system.h” #include “mupdf/fitz/context.h” #include “mupdf/fitz/geometry.h” #include “mupdf/fitz/store.h” #include “mupdf/fitz/separation.h”

/** Pixmaps represent a set of pixels for a 2 dimensional region of a plane. Each pixel has n components per pixel. The components are in the order process-components, spot-colors, alpha, where there can be 0 of any of those types. The data is in premultiplied alpha when rendering, but non-premultiplied for colorspace conversions and rescaling. 像素图表示二维区域的一组像素 一架飞机。 每个像素每个像素有 n 个分量。 组件 顺序是流程组件、专色、alpha，其中 这些类型中的任何一种都可以是 0。 数据在 渲染时预乘 alpha，但未预乘 色彩空间转换和重新缩放。 */

typedef struct fz_overprint fz_overprint;

/** Return the bounding box for a pixmap. 返回像素图的边界框。 */ fz_irect fz_pixmap_bbox(fz_context *ctx, const fz_pixmap *pix);

/** Return the width of the pixmap in pixels. 以像素为单位返回像素图的宽度。 */ int fz_pixmap_width(fz_context *ctx, const fz_pixmap *pix);

/** Return the height of the pixmap in pixels. 以像素为单位返回像素图的高度。 */ int fz_pixmap_height(fz_context *ctx, const fz_pixmap *pix);

/** Return the x value of the pixmap in pixels. 以像素为单位返回像素图的 x 值。 */ int fz_pixmap_x(fz_context *ctx, const fz_pixmap *pix);

/** Return the y value of the pixmap in pixels. 以像素为单位返回像素图的 y 值。 */ int fz_pixmap_y(fz_context *ctx, const fz_pixmap *pix);

/** Create a new pixmap, with its origin at (0,0)

*/ fz_pixmap *fz_new_pixmap(fz_context *ctx, fz_colorspace *cs, int w, int h, fz_separations *seps, int alpha);

/** Create a pixmap of a given size, location and pixel format.

*/ fz_pixmap *fz_new_pixmap_with_bbox(fz_context *ctx, fz_colorspace *colorspace, fz_irect bbox, fz_separations *seps, int alpha);

/** Create a new pixmap, with its origin at (0,0) using the supplied data block.

*/ fz_pixmap *fz_new_pixmap_with_data(fz_context *ctx, fz_colorspace *colorspace, int w, int h, fz_separations *seps, int alpha, int stride, unsigned char *samples);

/** Create a pixmap of a given size, location and pixel format, using the supplied data block.

*/ fz_pixmap *fz_new_pixmap_with_bbox_and_data(fz_context *ctx, fz_colorspace *colorspace, fz_irect rect, fz_separations *seps, int alpha, unsigned char *samples);

/** Create a new pixmap that represents a subarea of the specified pixmap. A reference is taken to this pixmap that will be dropped on destruction.

*/ fz_pixmap *fz_new_pixmap_from_pixmap(fz_context *ctx, fz_pixmap *pixmap, const fz_irect *rect);

/** Clone a pixmap, copying the pixels and associated data to new storage.

*/ fz_pixmap *fz_clone_pixmap(fz_context *ctx, const fz_pixmap *old);

/** Increment the reference count for the pixmap. The same pointer is returned.

*/ fz_pixmap *fz_keep_pixmap(fz_context *ctx, fz_pixmap *pix);

/** Decrement the reference count for the pixmap. When the reference count hits 0, the pixmap is freed.

*/ void fz_drop_pixmap(fz_context *ctx, fz_pixmap *pix);

/** Return the colorspace of a pixmap

*/ fz_colorspace *fz_pixmap_colorspace(fz_context *ctx, const fz_pixmap *pix);

/** Return the number of components in a pixmap.

*/ int fz_pixmap_components(fz_context *ctx, const fz_pixmap *pix);

/** Return the number of colorants in a pixmap.

*/ int fz_pixmap_colorants(fz_context *ctx, const fz_pixmap *pix);

/** Return the number of spots in a pixmap.

*/ int fz_pixmap_spots(fz_context *ctx, const fz_pixmap *pix);

/** Return the number of alpha planes in a pixmap.

*/ int fz_pixmap_alpha(fz_context *ctx, const fz_pixmap *pix);

/** Returns a pointer to the pixel data of a pixmap.

*/ unsigned char *fz_pixmap_samples(fz_context *ctx, const fz_pixmap *pix);

/** Return the number of bytes in a row in the pixmap. 返回像素图中一行中的字节数。 */ int fz_pixmap_stride(fz_context *ctx, const fz_pixmap *pix);

/** Set the pixels per inch resolution of the pixmap. 设置像素图的每英寸像素分辨率。 */ void fz_set_pixmap_resolution(fz_context *ctx, fz_pixmap *pix, int xres, int yres);

/** Clears a pixmap with the given value.

*/ void fz_clear_pixmap_with_value(fz_context *ctx, fz_pixmap *pix, int value);

/** Fill pixmap with solid color. 用纯色填充像素图。 */ void fz_fill_pixmap_with_color(fz_context *ctx, fz_pixmap *pix, fz_colorspace *colorspace, float *color, fz_color_params color_params);

/** Clears a subrect of a pixmap with the given value.

*/ void fz_clear_pixmap_rect_with_value(fz_context *ctx, fz_pixmap *pix, int value, fz_irect r);

/** Sets all components (including alpha) of all pixels in a pixmap to 0.

*/ void fz_clear_pixmap(fz_context *ctx, fz_pixmap *pix);

/** Invert all the pixels in a pixmap. All components (process and spots) of all pixels are inverted (except alpha, which is unchanged). 反转像素图中的所有像素。 所有组件（过程和 点）的所有像素都被反转（除了 alpha，它是 不变）。 */ void fz_invert_pixmap(fz_context *ctx, fz_pixmap *pix);

/** Transform the pixels in a pixmap so that luminance of each pixel is inverted, and the chrominance remains unchanged (as much as accuracy allows).

*/ void fz_invert_pixmap_luminance(fz_context *ctx, fz_pixmap *pix);

/** Tint all the pixels in an RGB, BGR, or Gray pixmap.

*/ void fz_tint_pixmap(fz_context *ctx, fz_pixmap *pix, int black, int white);

/** Invert all the pixels in a given rectangle of a pixmap. All components of all pixels in the rectangle are inverted (except alpha, which is unchanged). 反转给定矩形中的所有像素 像素图。 矩形中所有像素的所有分量都是 反转（除了 alpha，它没有变化）。 */ void fz_invert_pixmap_rect(fz_context *ctx, fz_pixmap *image, fz_irect rect);

/** Apply gamma correction to a pixmap. All components of all pixels are modified (except alpha, which is unchanged).

*/ void fz_gamma_pixmap(fz_context *ctx, fz_pixmap *pix, float gamma);

/** Convert an existing pixmap to a desired colorspace. Other properties of the pixmap, such as resolution and position are copied to the converted pixmap.

*/ fz_pixmap *fz_convert_pixmap(fz_context *ctx, const fz_pixmap *pix, fz_colorspace *cs_des, fz_colorspace *prf, fz_default_colorspaces *default_cs, fz_color_params color_params, int keep_alpha);

/** Check if the pixmap is a 1-channel image containing samples with only values 0 and 255 检查像素图是否是包含样本的 1 通道图像仅值 0 和 255 */ int fz_is_pixmap_monochrome(fz_context *ctx, fz_pixmap *pixmap);

/* Implementation details: subject to change. 实施细节：可能会发生变化 */

fz_pixmap *fz_alpha_from_gray(fz_context *ctx, fz_pixmap *gray); void fz_decode_tile(fz_context *ctx, fz_pixmap *pix, const float *decode); void fz_md5_pixmap(fz_context *ctx, fz_pixmap *pixmap, unsigned char digest[16]);

fz_stream * fz_unpack_stream(fz_context *ctx, fz_stream *src, int depth, int w, int h, int n, int indexed, int pad, int skip);

/** Pixmaps represent a set of pixels for a 2 dimensional region of a plane. Each pixel has n components per pixel. The components are in the order process-components, spot-colors, alpha, where there can be 0 of any of those types. The data is in premultiplied alpha when rendering, but non-premultiplied for colorspace conversions and rescaling.

*/ struct fz_pixmap { fz_storable storable; int x, y, w, h; unsigned char n; unsigned char s; unsigned char alpha; unsigned char flags; ptrdiff_t stride; fz_separations *seps; int xres, yres; fz_colorspace *colorspace; unsigned char *samples; fz_pixmap *underlying; };

enum { FZ_PIXMAP_FLAG_INTERPOLATE = 1, FZ_PIXMAP_FLAG_FREE_SAMPLES = 2 };

/* Create a new pixmap from a warped section of another. *

Colorspace, resolution etc are inherited from the original.

points give the corner points within the original pixmap of a

(convex) quadrilateral. These corner points will be ‘warped’ to be

the corner points of the returned bitmap, which will have the given

width/height. 从另一个扭曲的部分创建一个新的像素图。

色彩空间、分辨率等均继承自原版。 点给出了原始像素图中的角点 （凸）四边形。 这些角点将被“扭曲”为 返回位图的角点，将具有给定的 宽度/高度。 */ fz_pixmap * fz_warp_pixmap(fz_context *ctx, fz_pixmap *src, const fz_point points[4], int width, int height);

#endif